// Copyright (c) 2007, Luke Stratman
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, 
// are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, 
// this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright notice, this 
// list of conditions and the following disclaimer in the documentation and/or other 
// materials provided with the distribution.
//
// * Neither the name of Luke Stratman nor the names of its contributors may be used 
// to endorse or promote products derived from this software without specific prior 
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
// OF THE POSSIBILITY OF SUCH DAMAGE.
//
/////////////////////////////////////////////////////////////////////////////////////

using System;

namespace Rodunu.Services.NetFlix
{
    /// <summary>
    /// Exception that is thrown when an operation against a NetFlix queue (adding, removing,
    /// reordering, etc.) fails.
    /// </summary>
    public class QueueException : Exception
    {
        /// <summary>
        /// Default constructor.
        /// </summary>
        public QueueException()
            : base()
        {
        }

        /// <summary>
        /// Constructor that allows the user to pass in the return code we received back from
        /// NetFlix.
        /// </summary>
        /// <param name="resultCode">
        /// Return code that was received in response to the queue operation.
        /// </param>
        public QueueException(int resultCode)
            : base("The operation on the NetFlix queue failed with a result code of " + resultCode.ToString() + ".")
        {
        }

        /// <summary>
        /// Constructor that allows the user to pass in the return code we received back from
        /// NetFlix as well as an inner exception.
        /// </summary>
        /// <param name="resultCode">
        /// Return code that was received in response to the queue operation.
        /// </param>
        /// <param name="innerException">
        /// Inner exception for the current exception.
        /// </param>
        public QueueException(int resultCode, Exception innerException)
            : base("The operation on the NetFlix queue failed with a result code of " + resultCode.ToString() + ".", innerException)
        {
        }

        /// <summary>
        /// Constructor that allows the user to pass in a specific exception message.
        /// </summary>
        /// <param name="message">
        /// Message that should be included for the exception.
        /// </param>
        public QueueException(string message)
            : base(message)
        {
        }

        /// <summary>
        /// Constructor that allows the user to pass in a specific exception message as well as an
        /// inner exception.
        /// </summary>
        /// <param name="message">
        /// Message that should be included for the exception.
        /// </param>
        /// <param name="innerException">
        /// Inner exception for the current exception.
        /// </param>
        public QueueException(string message, Exception innerException)
            : base(message, innerException)
        {
        }
    }
}